\hypertarget{classCByteRingBuffer}{
\section{\-C\-Byte\-Ring\-Buffer \-Class \-Reference}
\label{classCByteRingBuffer}\index{\-C\-Byte\-Ring\-Buffer@{\-C\-Byte\-Ring\-Buffer}}
}


{\ttfamily \#include $<$byte\-\_\-ring\-\_\-buffer.\-h$>$}

\subsection*{\-Public \-Member \-Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classCByteRingBuffer_a2c3cfc5a6cef86165f6842fa289f52bc}{\-C\-Byte\-Ring\-Buffer} (unsigned int p\-Size)
\item 
virtual \hyperlink{classCByteRingBuffer_abb023db9ff4989543660ef8575cff29a}{$\sim$\-C\-Byte\-Ring\-Buffer} ()
\item 
void \hyperlink{classCByteRingBuffer_abbb1d906465b5272c59666de40406f15}{put} (unsigned char p\-Value)
\item 
void \hyperlink{classCByteRingBuffer_a60d974c20482161f0e193962e0e99aa1}{put} (void $\ast$p\-Values, unsigned int p\-Count)
\item 
unsigned int \hyperlink{classCByteRingBuffer_a6b4baec62462a7a882da2c838af7b195}{get} (void $\ast$p\-Dst, unsigned int p\-Count, bool p\-Clean=true)
\item 
int \hyperlink{classCByteRingBuffer_ae5f03da7789753a74471ce6ee04cf245}{get\-Index} (int p\-Offset)
\item 
unsigned int \hyperlink{classCByteRingBuffer_a5f637d617b4412e1cc67f62f96a3fe92}{clean} (unsigned int p\-Count)
\item 
bool \hyperlink{classCByteRingBuffer_a0b97cbe6d9e8c37a727e5e9cc7cff292}{clean\-First} ()
\item 
unsigned int \hyperlink{classCByteRingBuffer_a6b8c23abfe0dda4ffde708567ea5cbb8}{len} ()
\item 
unsigned int \hyperlink{classCByteRingBuffer_ab6bd347544efbc0561ff311557e52dc7}{size} ()
\end{DoxyCompactItemize}
\subsection*{\-Public \-Attributes}
\begin{DoxyCompactItemize}
\item 
std\-::valarray$<$ unsigned char $>$ \hyperlink{classCByteRingBuffer_aca119309072de93dba13115ef430bab1}{m\-Buffer}
\end{DoxyCompactItemize}
\subsection*{\-Private \-Attributes}
\begin{DoxyCompactItemize}
\item 
unsigned int \hyperlink{classCByteRingBuffer_a6974b34ed549d106e2c3b07d0fbeda55}{m\-Put}
\item 
unsigned int \hyperlink{classCByteRingBuffer_a5565fbabc87f1ba3922a1476f31b77e5}{m\-Get}
\item 
bool \hyperlink{classCByteRingBuffer_abd0e9011056d1d3dba8fb4281e7bbc00}{m\-Full}
\end{DoxyCompactItemize}


\subsection{\-Constructor \& \-Destructor \-Documentation}
\hypertarget{classCByteRingBuffer_a2c3cfc5a6cef86165f6842fa289f52bc}{
\index{\-C\-Byte\-Ring\-Buffer@{\-C\-Byte\-Ring\-Buffer}!\-C\-Byte\-Ring\-Buffer@{\-C\-Byte\-Ring\-Buffer}}
\index{\-C\-Byte\-Ring\-Buffer@{\-C\-Byte\-Ring\-Buffer}!CByteRingBuffer@{\-C\-Byte\-Ring\-Buffer}}
\subsubsection[{\-C\-Byte\-Ring\-Buffer}]{\setlength{\rightskip}{0pt plus 5cm}\-C\-Byte\-Ring\-Buffer\-::\-C\-Byte\-Ring\-Buffer (
\begin{DoxyParamCaption}
\item[{unsigned int}]{p\-Size}
\end{DoxyParamCaption}
)}}
\label{classCByteRingBuffer_a2c3cfc5a6cef86165f6842fa289f52bc}
\hypertarget{classCByteRingBuffer_abb023db9ff4989543660ef8575cff29a}{
\index{\-C\-Byte\-Ring\-Buffer@{\-C\-Byte\-Ring\-Buffer}!$\sim$\-C\-Byte\-Ring\-Buffer@{$\sim$\-C\-Byte\-Ring\-Buffer}}
\index{$\sim$\-C\-Byte\-Ring\-Buffer@{$\sim$\-C\-Byte\-Ring\-Buffer}!CByteRingBuffer@{\-C\-Byte\-Ring\-Buffer}}
\subsubsection[{$\sim$\-C\-Byte\-Ring\-Buffer}]{\setlength{\rightskip}{0pt plus 5cm}\-C\-Byte\-Ring\-Buffer\-::$\sim$\-C\-Byte\-Ring\-Buffer (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}
\label{classCByteRingBuffer_abb023db9ff4989543660ef8575cff29a}


\subsection{\-Member \-Function \-Documentation}
\hypertarget{classCByteRingBuffer_a5f637d617b4412e1cc67f62f96a3fe92}{
\index{\-C\-Byte\-Ring\-Buffer@{\-C\-Byte\-Ring\-Buffer}!clean@{clean}}
\index{clean@{clean}!CByteRingBuffer@{\-C\-Byte\-Ring\-Buffer}}
\subsubsection[{clean}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int \-C\-Byte\-Ring\-Buffer\-::clean (
\begin{DoxyParamCaption}
\item[{unsigned int}]{p\-Count}
\end{DoxyParamCaption}
)}}
\label{classCByteRingBuffer_a5f637d617b4412e1cc67f62f96a3fe92}
\hypertarget{classCByteRingBuffer_a0b97cbe6d9e8c37a727e5e9cc7cff292}{
\index{\-C\-Byte\-Ring\-Buffer@{\-C\-Byte\-Ring\-Buffer}!clean\-First@{clean\-First}}
\index{clean\-First@{clean\-First}!CByteRingBuffer@{\-C\-Byte\-Ring\-Buffer}}
\subsubsection[{clean\-First}]{\setlength{\rightskip}{0pt plus 5cm}bool \-C\-Byte\-Ring\-Buffer\-::clean\-First (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\label{classCByteRingBuffer_a0b97cbe6d9e8c37a727e5e9cc7cff292}
\hypertarget{classCByteRingBuffer_a6b4baec62462a7a882da2c838af7b195}{
\index{\-C\-Byte\-Ring\-Buffer@{\-C\-Byte\-Ring\-Buffer}!get@{get}}
\index{get@{get}!CByteRingBuffer@{\-C\-Byte\-Ring\-Buffer}}
\subsubsection[{get}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int \-C\-Byte\-Ring\-Buffer\-::get (
\begin{DoxyParamCaption}
\item[{void $\ast$}]{p\-Dst, }
\item[{unsigned int}]{p\-Count, }
\item[{bool}]{p\-Clean = {\ttfamily true}}
\end{DoxyParamCaption}
)}}
\label{classCByteRingBuffer_a6b4baec62462a7a882da2c838af7b195}

\begin{DoxyParams}{\-Parameters}
{\em p\-Clean} & true for removing from ring buffer \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{\-Returns}
count of stored values 
\end{DoxyReturn}
\hypertarget{classCByteRingBuffer_ae5f03da7789753a74471ce6ee04cf245}{
\index{\-C\-Byte\-Ring\-Buffer@{\-C\-Byte\-Ring\-Buffer}!get\-Index@{get\-Index}}
\index{get\-Index@{get\-Index}!CByteRingBuffer@{\-C\-Byte\-Ring\-Buffer}}
\subsubsection[{get\-Index}]{\setlength{\rightskip}{0pt plus 5cm}int \-C\-Byte\-Ring\-Buffer\-::get\-Index (
\begin{DoxyParamCaption}
\item[{int}]{p\-Offset}
\end{DoxyParamCaption}
)}}
\label{classCByteRingBuffer_ae5f03da7789753a74471ce6ee04cf245}
\hypertarget{classCByteRingBuffer_a6b8c23abfe0dda4ffde708567ea5cbb8}{
\index{\-C\-Byte\-Ring\-Buffer@{\-C\-Byte\-Ring\-Buffer}!len@{len}}
\index{len@{len}!CByteRingBuffer@{\-C\-Byte\-Ring\-Buffer}}
\subsubsection[{len}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int \-C\-Byte\-Ring\-Buffer\-::len (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\label{classCByteRingBuffer_a6b8c23abfe0dda4ffde708567ea5cbb8}
\hypertarget{classCByteRingBuffer_abbb1d906465b5272c59666de40406f15}{
\index{\-C\-Byte\-Ring\-Buffer@{\-C\-Byte\-Ring\-Buffer}!put@{put}}
\index{put@{put}!CByteRingBuffer@{\-C\-Byte\-Ring\-Buffer}}
\subsubsection[{put}]{\setlength{\rightskip}{0pt plus 5cm}void \-C\-Byte\-Ring\-Buffer\-::put (
\begin{DoxyParamCaption}
\item[{unsigned char}]{p\-Value}
\end{DoxyParamCaption}
)}}
\label{classCByteRingBuffer_abbb1d906465b5272c59666de40406f15}
\hypertarget{classCByteRingBuffer_a60d974c20482161f0e193962e0e99aa1}{
\index{\-C\-Byte\-Ring\-Buffer@{\-C\-Byte\-Ring\-Buffer}!put@{put}}
\index{put@{put}!CByteRingBuffer@{\-C\-Byte\-Ring\-Buffer}}
\subsubsection[{put}]{\setlength{\rightskip}{0pt plus 5cm}void \-C\-Byte\-Ring\-Buffer\-::put (
\begin{DoxyParamCaption}
\item[{void $\ast$}]{p\-Values, }
\item[{unsigned int}]{p\-Count}
\end{DoxyParamCaption}
)}}
\label{classCByteRingBuffer_a60d974c20482161f0e193962e0e99aa1}
\hypertarget{classCByteRingBuffer_ab6bd347544efbc0561ff311557e52dc7}{
\index{\-C\-Byte\-Ring\-Buffer@{\-C\-Byte\-Ring\-Buffer}!size@{size}}
\index{size@{size}!CByteRingBuffer@{\-C\-Byte\-Ring\-Buffer}}
\subsubsection[{size}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int \-C\-Byte\-Ring\-Buffer\-::size (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\label{classCByteRingBuffer_ab6bd347544efbc0561ff311557e52dc7}


\subsection{\-Member \-Data \-Documentation}
\hypertarget{classCByteRingBuffer_aca119309072de93dba13115ef430bab1}{
\index{\-C\-Byte\-Ring\-Buffer@{\-C\-Byte\-Ring\-Buffer}!m\-Buffer@{m\-Buffer}}
\index{m\-Buffer@{m\-Buffer}!CByteRingBuffer@{\-C\-Byte\-Ring\-Buffer}}
\subsubsection[{m\-Buffer}]{\setlength{\rightskip}{0pt plus 5cm}std\-::valarray$<$unsigned char$>$ {\bf \-C\-Byte\-Ring\-Buffer\-::m\-Buffer}}}
\label{classCByteRingBuffer_aca119309072de93dba13115ef430bab1}
\hypertarget{classCByteRingBuffer_abd0e9011056d1d3dba8fb4281e7bbc00}{
\index{\-C\-Byte\-Ring\-Buffer@{\-C\-Byte\-Ring\-Buffer}!m\-Full@{m\-Full}}
\index{m\-Full@{m\-Full}!CByteRingBuffer@{\-C\-Byte\-Ring\-Buffer}}
\subsubsection[{m\-Full}]{\setlength{\rightskip}{0pt plus 5cm}bool {\bf \-C\-Byte\-Ring\-Buffer\-::m\-Full}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}
\label{classCByteRingBuffer_abd0e9011056d1d3dba8fb4281e7bbc00}
\hypertarget{classCByteRingBuffer_a5565fbabc87f1ba3922a1476f31b77e5}{
\index{\-C\-Byte\-Ring\-Buffer@{\-C\-Byte\-Ring\-Buffer}!m\-Get@{m\-Get}}
\index{m\-Get@{m\-Get}!CByteRingBuffer@{\-C\-Byte\-Ring\-Buffer}}
\subsubsection[{m\-Get}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int {\bf \-C\-Byte\-Ring\-Buffer\-::m\-Get}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}
\label{classCByteRingBuffer_a5565fbabc87f1ba3922a1476f31b77e5}
\hypertarget{classCByteRingBuffer_a6974b34ed549d106e2c3b07d0fbeda55}{
\index{\-C\-Byte\-Ring\-Buffer@{\-C\-Byte\-Ring\-Buffer}!m\-Put@{m\-Put}}
\index{m\-Put@{m\-Put}!CByteRingBuffer@{\-C\-Byte\-Ring\-Buffer}}
\subsubsection[{m\-Put}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int {\bf \-C\-Byte\-Ring\-Buffer\-::m\-Put}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}
\label{classCByteRingBuffer_a6974b34ed549d106e2c3b07d0fbeda55}


\-The documentation for this class was generated from the following files\-:\begin{DoxyCompactItemize}
\item 
\hyperlink{byte__ring__buffer_8h}{byte\-\_\-ring\-\_\-buffer.\-h}\item 
\hyperlink{byte__ring__buffer_8cxx}{byte\-\_\-ring\-\_\-buffer.\-cxx}\end{DoxyCompactItemize}
